.TH std::map::erase 3 "2024.06.10" "http://cppreference.com" "C++ Standard Libary"
.SH NAME
std::map::erase \- std::map::erase

.SH Synopsis
   iterator erase( iterator pos );                      \fB(1)\fP
   iterator erase( const_iterator pos );                \fB(2)\fP \fI(since C++11)\fP
   iterator erase( iterator first, iterator last );                       \fI(until C++11)\fP
   iterator erase( const_iterator first, const_iterator                   \fI(since C++11)\fP
   last );                                              \fB(3)\fP
   size_type erase( const Key& key );                       \fB(4)\fP
   template< class K >                                      \fB(5)\fP           (since C++23)
   size_type erase( K&& x );

   Removes specified elements from the container.

   1,2) Removes the element at pos.
   3) Removes the elements in the range [first, last), which must be a valid range in
   *this.
   4) Removes the element (if one exists) with the key equivalent to key.
   5) Removes all elements with key that compares equivalent to the value x. This
   overload participates in overload resolution only if the qualified-id
   Compare::is_transparent is valid and denotes a type, and neither iterator nor
   const_iterator is implicitly convertible from K. It allows calling this function
   without constructing an instance of Key.

   References and iterators to the erased elements are invalidated. Other references
   and iterators are not affected.

   The iterator pos must be valid and dereferenceable. Thus the end() iterator (which
   is valid, but is not dereferenceable) cannot be used as a value for pos.

.SH Parameters

   pos         - iterator to the element to remove
   first, last - range of elements to remove
   key         - key value of the elements to remove
   x           - a value of any type that can be transparently compared with a key
                 denoting the elements to remove

.SH Return value

   1-3) Iterator following the last removed element.
   4) Number of elements removed (0 or 1).
   5) Number of elements removed.

.SH Exceptions

   1-3) Throws nothing.
   4,5) Any exceptions thrown by the Compare object.

.SH Complexity

   Given an instance c of map:

   1,2) Amortized constant
   3) log(c.size()) + std::distance(first, last)
   4) log(c.size()) + c.count(key)
   5) log(c.size()) + c.count(x)

.SH Notes

               Feature-test macro               Value    Std           Feature
                                                               Heterogeneous erasure in
                                                               associative containers
   __cpp_lib_associative_heterogeneous_erasure 202110L (C++23) and unordered
                                                               associative containers;
                                                               overload \fB(5)\fP

.SH Example


// Run this code

 #include <map>
 #include <iostream>

 int main()
 {
     std::map<int, std::string> c =
     {
         {1, "one"}, {2, "two"}, {3, "three"},
         {4, "four"}, {5, "five"}, {6, "six"}
     };

     // erase all odd numbers from c
     for (auto it = c.begin(); it != c.end();)
     {
         if (it->first % 2 != 0)
             it = c.erase(it);
         else
             ++it;
     }

     for (auto& p : c)
         std::cout << p.second << ' ';
     std::cout << '\\n';
 }

.SH Output:

 two four six

  Defect reports

   The following behavior-changing defect reports were applied retroactively to
   previously published C++ standards.

      DR    Applied to          Behavior as published              Correct behavior
                       the return type of overloads \fB(1)\fP and \fB(3)\fP
   LWG 130  C++98      was void (it is not                      corrected to iterator
                       consistent with the erase() requirement
                       on sequence containers)
   LWG 2059 C++11      replacing overload \fB(1)\fP with overload \fB(2)\fP added overload (1) back
                       introduced new ambiguity

.SH See also

   clear clears the contents
         \fI(public member function)\fP
